文档 / 快速开始

快速开始：5 分钟创建你的第一个应用

1. 注册并创建应用

  1. 打开控制台 https://console.ocps.cc，登录（或注册）账号；
  2. 进入 应用管理 → 创建应用，填写应用名称、选择类型（内容站 / 工具站 / 游戏站 / 官网 / 电商）；
  3. 创建成功后，进入应用详情页，你会拿到一组凭据：
appid  = app-xxxxxxxx          # 应用 ID（租户标识，所有数据按它隔离）
ak     = ak-xxxxxxxx           # Access Key（访问密钥 ID）
sk     = sk-xxxxxxxxxxxxxxxx   # Secret Key（签名密钥，仅此一次展示，务必保存）
凭据安全：sk 只能保存在你的服务端环境变量里，绝不可放进前端 JS。

2. 授权 scope（能力权限）

应用默认开通常用 scope（内容读写、分类读写、用户读写、认证）。在应用详情 → 授权 scope 页面，可按需开通：

能力scope 示例说明
内容content:read content:write文章/内容 CRUD 与发布
分类category:read category:write分类树/导航
用户user:read user:write用户主数据
认证auth:token登录换令牌
媒体media:write上传文件
AIai:generate文生图 / 对话等
模板templates:use templates:publish安装/发布模板
支付pay:create创建订单

3. 跑通第一个 API：读取你的应用设置

curl -X GET "https://api.ocps.cc/app/v1/apps/{appid}/settings" \
  -H "X-AK: {ak}" \
  -H "X-Signature: {signature}" \
  -H "X-Timestamp: {unix_second}" \
  -H "X-Nonce: {random}"

签名算法见 API 签名与鉴权。嫌手算麻烦？直接使用官方 SDK：

// Node.js
const { OcpsClient } = require('ocps-sdk');
const client = new OcpsClient({ baseUrl: 'https://api.ocps.cc', ak, sk, appid });
const r = await client.get('/app/v1/apps/' + appid + '/settings');
console.log(r.items);

4. 选择你的接入形态

  • 不想写代码：用模板市集直接装一个现成模板（内容站/官网/游戏站），后台可视化改区块；
  • 前端三端：网站 / 小程序 / App 都通过同一套 API 对接；
  • 后端 SSR：用官方 Laravel 模板（template-laravel）快速起步，SEO 友好。

5. 下一步